-
-
Notifications
You must be signed in to change notification settings - Fork 175
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add readme file to perform as documentation index #12
Conversation
The last commit was wrongly added to this PR was meant to be a separate on. |
Do you want to merge this with the last commit? It can be removed if needed - just reset the branch to previous commit and push --force. While in most cases 'force push' is bad, in this particular scenario it's not a big deal, as it is your branch and most likely not shared with others. |
shhh.... if you don't tell anyone I think this can safely go along with the other commits... 😉 |
# nanoFramework Documentation | ||
|
||
[Building nanoFramework] (build-instructions.md) | ||
[Debug with VS Code] (vscode-debug-instructions.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These two links are rendered on the same line - wouldn't it be better to use a list instead? Also, the space between '[' and '(' does not work in Visual Studio Code markdown preview.
😓
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for spotting that. I overlooked it and thought that it was an issue with VS Code renderer for md files... my bad!
- rework formating to correct erros in the markup - improve some styling with lists and names - rename readme files to upper case to follow GitHub common practices
I've taken the opportunity to add documentation on some of the CMake modules and files as a walkthrough to help someone that want's to work on this part. |
…580c-196b-48c8-9817-cca5540acfc8 Code style fixes for nanoframework/nf-interpreter PR#2849
No description provided.